home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / pxdos_20.zip / POLYXARC.DOC < prev    next >
Text File  |  1990-04-09  |  31KB  |  673 lines
  1.  
  2.                                                                 page 1
  3.  
  4.  
  5.                                     PolyXarc
  6.                                v2.0  9 April 1990
  7.                        Public domain by Jeffrey J. Nonken
  8.                             Amiga port by Steve Palm
  9.                             OS/2 port by Bill Andrus
  10.  
  11.         By  giving this away, complete with source code and docs, I  hope 
  12.         to  encourage others to do likewise. I think we can all  gain  in 
  13.         the long run by sharing. Public Domain means that nobody owns it. 
  14.         You  can  give  it away, sell it,  incorporate  bits  into  other 
  15.         programs, whatever you want. However, in the interests of program 
  16.         management,  I request that if you make changes that may  benefit 
  17.         others, you
  18.          1) Share them with us;
  19.          2) Send me a copy of source so I can make an 'official' release.
  20.  
  21.         Warrantee: none.
  22.  
  23.         Address  netmail to 1:273/715 in Fidonet. If you wish to log  on, 
  24.         call (215)279-9799 (300/1200/2400/9600/14400 HST/V.32),  PCPable. 
  25.         You  can get the latest distribution version of PolyXarc by  file 
  26.         requesting POLYXARC from 1:273/715. If you wish to send  anything 
  27.         via U.S. Snail, write to:
  28.  
  29.                                Jeffrey J. Nonken
  30.                                507 Ave. Presidio
  31.                                San Clemente, Ca. 92672
  32.  
  33.         NOTE:  Version  2.0 has major changes in the  configuration  file 
  34.         syntax. VERSION 1.x CONFIGURATION FILES WILL NOT WORK WITH 2.x! I 
  35.         have  made  no  attempts to detect old  configuration  files  and 
  36.         provide correction or warning; that would complicate and  enlarge 
  37.         PolyXarc  unnecessarily.  It  is  up to you  to  make  sure  your 
  38.         configuration files have been replaced or updated.
  39.  
  40.         WHAT IT IS
  41.         ==========
  42.         "Poly"  means  "many",  and  "Xarc"  means  "archive  extractor". 
  43.         PolyXarc  is a program that permits automatic extraction of  most 
  44.         known  archive formats. By "Xarc" I do not necessarily  refer  to 
  45.         SEA's  ARC program or the file format supported by ARC  (which  I 
  46.         will  refer  to  as  ".ARC  format"  herein),  although  PolyXarc 
  47.         supports  both. The purpose of this program is to  allow  Fidonet 
  48.         BBS  system operators to automatically extract bundles that  have 
  49.         been  made  with various archive programs.  Traditionally  sysops 
  50.         have   use  one .ARC  format  program  or  another.  But   recent 
  51.         improvements  in  compression techniques, along  with  a  rapidly 
  52.         climbing  volume of echomail, have encouraged sysops to  look  at 
  53.         other programs.
  54.  
  55.         It  is not my purpose to praise one archive format over  another. 
  56.         In fact, the whole purpose of this program is to support as  wide 
  57.         a variety as possible. 
  58.  
  59.  
  60.  
  61.  
  62.            PolyXarc 2.0: multiple-format archive extractor executive
  63.                                                                 page 2
  64.  
  65.  
  66.         PolyXarc   does  not  itself  extract  archive  files;   PolyXarc 
  67.         identifies   which  format  is  being  used  and  calls  on   the 
  68.         appropriate  archive extractor program to do the actual work.  In 
  69.         this  lies  its  flexibility. Think of PolyXarc  as  an  "Archive 
  70.         Extractor Executive".
  71.  
  72.         PolyXarc is a direct replacement for SPAZ v1.40 (developed by Dan 
  73.         Thomson  and Andrew Farmer), except that PolyXarc is much  larger 
  74.         (about 35k vs. 6k) and may not work in cases where memory is at a 
  75.         premium. However, the SPAZ developers have not been able to  keep 
  76.         up  with recent developments. Therefore I wrote PolyXarc to  take 
  77.         up the slack.
  78.  
  79.         Aside  from  maintaining  compatibility  with  SPAZ,  I  designed 
  80.         PolyXarc with three major goals in mind:
  81.           - directly executable by Opus (replaces ARCE) or other mailers;
  82.           - stand-alone (can automatically extract all mail bundles);
  83.           - maximum flexibility.
  84.  
  85.         PolyXarc supports one critical command-line switch that SPAZ 1.40 
  86.         does not: the '/r' switch. Opus 1.0x passes a '/r' switch to ARCE 
  87.         to force it to overwrite existing files, and SPAZ will exit  with 
  88.         an error if it sees that switch, making it unsuitable for use  as 
  89.         a  direct ARCE replacement. PolyXarc will accept either  '/r'  or 
  90.         SPAZ's '/o'.
  91.  
  92.         PolyXarc also duplicates SPAZ's ability to find all mail  bundles 
  93.         in a specified directory and de-archive all of them. In addition, 
  94.         PolyXarc  will  sort the files by  their  date/timestamps  before 
  95.         beginning  extraction to assure that the packets are, as much  as 
  96.         possible, extracted in the correct order. PolyXarc also gives you 
  97.         the choice of limiting the number of archives that it extracts in 
  98.         a session so that you can process them a few at a time instead of 
  99.         all at once.
  100.  
  101.         I  tried to write PolyXarc to be as flexible and expandable as  I 
  102.         could  within reason. Unlike most multi-archive mail  unbundlers, 
  103.         except  for some .ARC format recognition, PolyXarc does not  have 
  104.         any specific format recognition built in. Instead, PolyXarc has a 
  105.         configuration  file that contains signature strings  and  command 
  106.         line  templates, allowing you to expand  PolyXarc's  capabilities 
  107.         without having to write any code. In addition, you can  customize 
  108.         PolyXarc's recognition of .ARC format compression flags, and tell 
  109.         it  which  program to use for which flag. However,  if  all  else 
  110.         fails, and you come upon a format which PolyXarc is not  equipped 
  111.         to handle, you can alter the source to accomodate it, for I  have 
  112.         released  the  source  code  to the  public  domain.  This  gives 
  113.         unlimited  permission  for  anybody  to  alter  it,  providing  a 
  114.         permanent upgrade path.
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.            PolyXarc 2.0: multiple-format archive extractor executive
  124.                                                                 page 3
  125.  
  126.  
  127.         The  one thing SPAZ has that PolyXarc does not support is the  -A 
  128.         switch. That causes SPAZ to limit itself to using ARCE for  level 
  129.         8 .ARC format files. Since PolyXarc on one hand does not directly 
  130.         support any specific program, and on the other hand is completely 
  131.         configurable,  it makes no sense for PolyXarc to support  the  -A 
  132.         flag.  If -A shows up on the command line, PolyXarc  will  ignore 
  133.         it.
  134.  
  135.         HOW TO USE IT
  136.         =============
  137.         PolyXarc's syntax is:
  138.  
  139.           PolyXarc [switches] archive [name [name...]] [switches]
  140.  
  141.         Recognized switches are:
  142.           -Cconfig               -I                     -O                     
  143.           -D                     -Maddr                 -R                     
  144.           -F[n]                  -N                     -Q                     
  145.  
  146.  
  147.         archive
  148.  
  149.         This is the name of the archive file you wish to extract from, or 
  150.         if  you  specify the -F switch, the path where mail  bundles  are 
  151.         kept. In the former case (not using -F) wildcards are  supported, 
  152.         and  if you do not supply an extension, PolyXarc will  assume  an 
  153.         extension  of  ".*".  In the latter case  (using  -F),  you  must 
  154.         specify a path ONLY, not a file name. Also, if you specify -F you 
  155.         may leave the archive path out completely and it will default  to 
  156.         the current directory.
  157.  
  158.         name...
  159.  
  160.         This  is  one or more names of files within the archive.  If  you 
  161.         list  more  than one name, they should be  separated  by  spaces. 
  162.         These are optional. If left off, most extractors will assume that 
  163.         you  want  to  extract all files. The  only  limitation  is  that 
  164.         PolyXarc expects an archive or path nam